home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / update20.zip / UPDATE.DOC < prev    next >
Text File  |  1989-03-12  |  8KB  |  190 lines
  1.   ***********************************************************************
  2.   *                      AutoUpdate version 2.00                        *
  3.   *                   Copyright 1989, by Steve Jones                    *
  4.   ***********************************************************************
  5.  
  6. This file is part of UPDATE20.ARC, which contains the following
  7. files:
  8.          UPDATE.DOC   This file
  9.          UPDATE.EXE   User Update executable file
  10.          UPDATE.CTL   Sample control file
  11.  
  12. **DO NOT RUN UPDATE WITH THE DEMO .CFG FILE!  IT WILL CHANGE YOUR USERLOG!**
  13.  
  14. Although as of the release of this program, it is running
  15. reliably on my own system, I can not, and will not be held
  16. responsible for any damages, to your system, due to the use, or
  17. misuse of this program.  Much care has been taken to insure the
  18. safety of your BBS's system files (USERS.BBS, and MSG*.BBS), for
  19. example, all message files are closed after each message is sent,
  20. so that a power failure would have a minimal chance of hurting
  21. your data, but, as with any program that modifies these files,
  22. there is always a slight chance that something could go wrong.
  23.  
  24. Remember:  WHEN IN DOUBT, BACK IT UP!
  25.  
  26. AutoUpdate (formerly UserUpdate) may be distributed freely,
  27. as long as no fee is charged, over the reasonable cost of the
  28. media it is delivered on, or a charge for the connect time
  29. involved with transfering it.  The contents of the archive may
  30. not be distributed seperately, but MUST be distributed as some
  31. sort of package, weather it is ARC, PAK, ZIP, or ZOO.  If you find
  32. AutoUpdate a valuable tool in running your QuickBBS, please let
  33. me know, by NetMail, at 109/410 in the fidonet, or by writing to:
  34.  
  35.                          316 Duxbury Drive
  36.                          Silver Spring, MD 20904
  37.  
  38. Flames > nul, please...  CONSTRUCTIVE criticism accepted, and
  39. solicited.  If you feel it is worth it, include a small donation
  40. with your comments ($5.00 or less...)
  41.  
  42. The AutoUpdate program's function is to update the QuickBBS
  43. USERS.BBS file, altering ONLY a users access level, depending on
  44. how much they participate on your BBS.  It will raise, or lower,
  45. a users access depending on guidelines found in the UPDATE.CTL
  46. file, a sample of which is included with this package.
  47. A new feature of version 2.00 is to also optionally send a message
  48. to the user, alerting him to the fact that his access was changed by
  49. AutoUpdate.
  50.  
  51. The format of the .CTL file is:   A raw ASCII text file, with a
  52. single command and parameter on each line.  More than one set of
  53. rules may be in the .CTL file, separated by EXACLY ONE blank
  54. line.  The commands are:
  55.  
  56. Net
  57. Node
  58. Zone
  59. BoardNumber
  60. SecLvlMin
  61. SecLvlMax
  62. SecLvlNew
  63. TimesPosted
  64. HighMsgRead
  65. Times (or TimesCalled, or Called)
  66. Uploads
  67. Downloads
  68.  
  69. Each command is followed by (at least) one space, and a number.
  70. Net, Node, and Zone, are actually only used in the message sent
  71. to the user.  If you don't define these, I am not sure what will
  72. happen, but it *SHOULD* work, as long as the message isn't
  73. placed into your netmail area.  On a QuickBBS implementation
  74. without Net/echomail, I suppose these would have no effect.
  75. Boardnumber is the number, 1-200, of the message board that the
  76. messages to the users should be placed into.  If this is not
  77. specified, no messages will be sent.  Also, you can put a
  78. different board number in each set of update parameters, so that
  79. upgrade notices would be put in one area, and downgrades in
  80. another.  You can reset this to 0 if you don't want messages to
  81. be output for a specific set of rules.
  82. The rest of the commands define parameters as to when a user
  83. should be modified.  The numbers are the high or low bounds to
  84. qualify the user for that particular change.
  85.  
  86. Each bound is translated as "If the users value is at least
  87. equal to" the value on the line, then it will be true, unless the
  88. number is preceded by "-", in which case, it will be interpreted
  89. as "if it is not more than" the number.  The following is an
  90. example:
  91.  
  92. SecLvlmin 1
  93. SecLvlMax 10
  94. TimesPosted 3
  95. Times 2
  96. Downloads -2
  97. SecLvlNew 20
  98.  
  99.  
  100.    This example would effect users with current access of 1 through
  101. 10, and update them to 20, if they have posted at least 3
  102. messages, logged on at least twice, and have downloaded LESS THAN
  103. 2 files.  This example would NOT send messages to the user,
  104. unless a boardnumber was set by a previous set of rules.
  105. (Boardnumber, and node address parameters stay constant until
  106. reset by another command, all others are cleared after each set
  107. of rules)
  108.  
  109. Case is not important in any of the commands. Also, the commands
  110. may appear in any order.  Any commands which are excluded from a
  111. set of rules is ignored when considering that set of rules.
  112.  
  113.  
  114.   Since any user who doesn't meet even ONE of the parameters will
  115. be ignored, it may be necessary to put in more than one set of
  116. rules (In the above example, you may get a user, who on his first
  117. call, downloads 2 files, then on his next calls, there is no way
  118. he could be upgraded, since he doesn't meet the needs of line 7).
  119. To do this, you would need to append another set of rules
  120. DIRECTLY to the end of the .CTL file..  You should have one
  121. blank line between the sets of rules..  An example of a second set of
  122. rules added to that first one, is:
  123.  
  124. SecLvlmin 1
  125. SecLvlMax 10
  126. TimesPosted 3
  127. Times 2
  128. Downloads -2
  129. SecLvlNew 20
  130.  
  131. Seclvlmin 20
  132. seclvlmax   30
  133. timesposted -10
  134. downloads 10
  135. seclvlnew 5
  136. Boardnumber 3
  137.  
  138. This second det of rules would take any user who is between level
  139. 20 and 30, and put them *DOWN* to level 10, if they had posted
  140. less than 10 messages, and downloaded 10 or more files.  As you
  141. can see, the number of calls, or messages read would make no
  142. impact in the second set of rules.  Any user having his/her
  143. access changed by the second set of rules in this example would
  144. also recieve a message in base number 3, notifying them that they
  145. have been automatically decreased by AutoUpdate due to their
  146. participation level.
  147.  
  148. UPDATE terminates when one of three things happens:
  149. 1>  End of the .CTL file is reached
  150. 2>  2 blank lines in a row are reached
  151. 3>  Seclvlmax = 0 and seclvlnew = 0 in any particular set of
  152.     rules.  in a set of rules with these parameters, no change
  153.     would be possible, so the program assumes you are done.
  154.  
  155. You can have as many sets of rules as you want.  The system will
  156. go through the entire userlog once for each rule, so the more
  157. rules you have, the longer the run will take.
  158.  
  159. As the program runs, it will print "Checking users..." each time
  160. it loads a new set of rules, just to let you know it is working.
  161. It will also list each user who recieves a message.
  162.  
  163. As for where the program is to be run, you must be in the same
  164. directory as the UPDATE.CTL, MSG*.BBS, and USERS.BBS files, but the
  165. UPDATE.EXE can be anywhere in the path.
  166.  
  167. I am sorry the documentation isn't the best in the world, but, I
  168. believe they are good enough to get the job done.  If you have
  169. any additions which would be good to make, in the program, or the
  170. docs,  please let me know, I will do my best, although working 2
  171. jobs, and going to school part time prevents me from spending
  172. much time on anything that isn't a change which is useful to
  173. everyone.
  174.  
  175. I will do my best to reply to all NetMail, or mesages in the
  176. QuickBBS echo, addressed to me, (Steve Jones or SysOp) at 109/410,
  177. and also to mail recieved with a SASE through normal mail.
  178.  
  179. Well..  Have fun with all the time this program should save you
  180. in manual updates of your userlog!
  181.  
  182. Thank you for using AutoUpdate 2.00.  Please pass the
  183. UPDATE20.ARC file on to other BBS's, and QuickBBS sysops and
  184. potential SysOps.
  185.  
  186.    Steve Jones, 109/410
  187.    Midi Thru BBS
  188.    (301)384-0351 2400 baud 24 hours, #CM
  189.  
  190.